Add dynamic linking feature that generates links to versioned Javadocs #817
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a feature that dynamically generates links to versioned Javadocs based on the version of the docs that the visitor is viewing. By implementing this feature, we can:
Note
After implementing this feature, we'll need to use the following syntax to add links to Javadocs:
The syntax for the Javadoc link above is as follows:
https://javadoc.io/static/com.scalar-labs/<PACKAGE_NAME>/3.10.0/<PATH>/<CLASS_NAME>.htmlRelated issues and/or PRs
N/A
Changes made
className(a native field in Docusaurus) to the versions section of docusaurus.config.js. TheclassNameshould be the latest version (major.minor.patch) version for thatmajor.minorversion.Checklist
Additional notes (optional)
N/A